Fzzy Config/me.fzzyhmstrs.fzzy_config.screen.widget.custom/CustomButtonWidget

CustomButtonWidget

open class CustomButtonWidget : CustomPressableWidget

A custom ButtonWidget implementation with builder and rendering improvements (and more features in general)

This constructor is for subclasses of this widget only. Buttons should be constructed with the builder, like vanilla buttons.

Author

fzzyhmstrs

Since

0.5.?

Parameters

button X position

button Y position

width

button width in pixels

height

button height in pixels

pressAction

Consumer<CustomButtonWidget> action to invoke when the button is clicked or activated

narrationSupplier

ButtonWidget.NarrationSupplier same use as in vanilla; converts a provided input text into a narration text.

narrationAppender

Consumer<NarrationMessageBuilder> unlike the supplier, this is used to directly append additional narrations as needed to the message builder.

textures

TextureSet, default CustomPressableWidget.DEFAULT_TEXTURES. The textures for this button

child

TooltipChild, used to pass additional tooltip context. This button will pass and tooltip from this child out to its own parent (this button is also a TooltipChild)

renderMessage

If false, the label won't be rendered

Types

Builder

class Builder(message: Text, onPress: Consumer<CustomButtonWidget>)

Builds a CustomButtonWidget

Companion

object Companion

Properties

var active: Boolean

var focused: Boolean

var message: Text

var navigationOrder: Int

visible

var visible: Boolean

var x: Int

var y: Int

Functions

appendNarrations

override fun appendNarrations(builder: NarrationMessageBuilder)

charTyped

open fun charTyped(chr: Char, modifiers: Int): Boolean

drawMessage

open fun drawMessage(context: DrawContext, textRenderer: TextRenderer, x: Int, y: Int, width: Int, height: Int, color: Int)

Draws the widgets message with standard edge padding and positioning.

forEachChild

open override fun forEachChild(consumer: Consumer<ClickableWidget>)

getBottom

open fun getBottom(): Int

getFocusedPath

@Nullable

open fun getFocusedPath(): GuiNavigationPath?

getHeight

open override fun getHeight(): Int

getNavigationFocus

open override fun getNavigationFocus(): ScreenRect

getNavigationPath

@Nullable

open override fun getNavigationPath(navigation: GuiNavigation): GuiNavigationPath?

getRight

open fun getRight(): Int

getTooltip

@Nullable

open fun getTooltip(): Tooltip?

getType

open override fun getType(): Selectable.SelectionType

getWidth

open override fun getWidth(): Int

isHovered

open fun isHovered(): Boolean

isMouseOver

open override fun isMouseOver(mouseX: Double, mouseY: Double): Boolean

isNarratable

open override fun isNarratable(): Boolean

isSelected

open fun isSelected(): Boolean

keyReleased

open fun keyReleased(keyCode: Int, scanCode: Int, modifiers: Int): Boolean

mouseClicked

open override fun mouseClicked(mouseX: Double, mouseY: Double, button: Int): Boolean

mouseDragged

open override fun mouseDragged(mouseX: Double, mouseY: Double, button: Int, deltaX: Double, deltaY: Double): Boolean

mouseMoved

open fun mouseMoved(mouseX: Double, mouseY: Double)

mouseReleased

open override fun mouseReleased(mouseX: Double, mouseY: Double, button: Int): Boolean

mouseScrolled

open fun mouseScrolled(mouseX: Double, mouseY: Double, horizontalAmount: Double, verticalAmount: Double): Boolean

onPress

open override fun onPress()

Action invoked whenever the button is clicked on or activated with Enter.

onRelease

open fun onRelease(mouseX: Double, mouseY: Double)

playDownSound

open fun playDownSound(soundManager: SoundManager)

provideNarrationLines

open fun provideNarrationLines(): List<Text>

Provides a list of text for appending into a Narration Hint. By default this will use the same lines passed from provideTooltipLines, with predefined values for the inputs

provideTooltipLines

open override fun provideTooltipLines(mouseX: Int, mouseY: Int, parentSelected: Boolean, keyboardFocused: Boolean): List<Text>

Provides a list of text lines for appending to a tooltip. Unlike appending in MC, the parent has final say on compiling the tooltip from the pieces given to it.

render

override fun render(context: DrawContext, mouseX: Int, mouseY: Int, delta: Float)

renderBackground

open fun renderBackground(context: DrawContext, x: Int, y: Int, width: Int, height: Int, mouseX: Int, mouseY: Int, delta: Float)

Custom background rendering for the widget. By default, will render the standard MC button texture set.

renderCustom

open override fun renderCustom(context: DrawContext, x: Int, y: Int, width: Int, height: Int, mouseX: Int, mouseY: Int, delta: Float)

Custom foreground rendering for the widget. By default, will render the label.

setAlpha

open fun setAlpha(alpha: Float)

setDimensions

open fun setDimensions(width: Int, height: Int)

setDimensionsAndPosition

open fun setDimensionsAndPosition(width: Int, height: Int, x: Int, y: Int)

setHeight

open fun setHeight(height: Int)

setPosition

open fun setPosition(x: Int, y: Int)

setTooltip

open fun setTooltip(@Nullable tooltip: Tooltip?)

setTooltipDelay

open fun setTooltipDelay(tooltipDelay: Duration)

setWidth

open fun setWidth(width: Int)